FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.eu.fhir.gh#current (16 ms)

Package hl7.eu.fhir.gh
Type OperationDefinition
Id Id
FHIR Version R5
Source http://hl7.eu/fhir/ig/gravitate-health/https://build.fhir.org/ig/hl7-eu/gravitate-health/OperationDefinition-focus.html
Url http://hl7.eu/fhir/ig/gravitate-health/OperationDefinition/focus
Version 0.1.0
Status active
Date 2024-12-16T11:58:55+00:00
Name focus
Title focus
Experimental False
Realm eu
Authority hl7
Description This operation calculates a focused version of an ePI as well as the separate extracts. The IPS can either be submitted as an IPS bundle or as an `Identifer` of the patient (using the `ips-identifier` parameter). If neither IPS Bundle or IPS identifier are passed as parameters it is expected that the `Identifier` of the patient is present as part of the security token. If the `Identifier` of the patient is submitted as an Identifier or as part of a security token it is up to the discression of the service implementing the `focus`-operation to fetch the IPS of the patient. If the IPS is delivered as a bundle it must be encoded using Base64 as it is FHIR R4 compliant whereas the `focus`-operation is FHIR R5 compliant. The `focus`-operation will internally convert and extract the needed information from the R4 bundle. The ePI can be delivered either as a `Bundle` or by using an `Identifier` of the bundle. Whether the support of both `Identifier` and `Bundle` continues to be supported currently remains unknown. The persona dimension can be delivered either as a `Bundle` or by using an `Identifier` of the bundle. Whether the support of both `Identifier` and `Bundle` continues to be supported currently remains unknown. **Note: If the IPS is delivered as encoded Base64 content, there is a better opportunity for the submitting client to de-identify the Patient resource as the client can remove the Patient.identifier and mask out names and so on. While this may seem counter intuitive from an IPS point of view, the Patient identifiable components are not needed for the focusing mechanism to operate properly.**
Type false
Kind operation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition focus

URL: [base]/$focus

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INips0..1base64Binary

IPS bundle packaged as base64Binary in order not to mix FHIR R4 with FHIR R5.

INips-identifier0..1Identifier

IPS Patient Identifier

INepi0..1Bundle

ePI Document Bundle

INepi-identifier0..1Identifier

ePI Document Identifier

INpv0..1Bundle

Persona Vector

INpv-identifier0..1Identifier

Persona Vector Identifier

INlanguage0..1Coding

Language of the ePI. The code must be picked from https://hl7.org/fhir/valueset-languages.html. Defaults to english if none is provided.

OUTreturnEpi1..1Bundle

Focused epi Bundle

OUTreturnEpiExtracts0..1Bundle

Focused epi Bundle extracts


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "focus",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition focus</b></p><a name=\"focus\"> </a><a name=\"hcfocus\"> </a><a name=\"focus-en-US\"> </a><p>URL: [base]/$focus</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>ips</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#base64Binary\">base64Binary</a></td><td/><td><div><p>IPS bundle packaged as base64Binary in order not to mix FHIR R4 with FHIR R5.</p>\n</div></td></tr><tr><td>IN</td><td>ips-identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>IPS Patient Identifier</p>\n</div></td></tr><tr><td>IN</td><td>epi</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/bundle.html\">Bundle</a></td><td/><td><div><p>ePI Document Bundle</p>\n</div></td></tr><tr><td>IN</td><td>epi-identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>ePI Document Identifier</p>\n</div></td></tr><tr><td>IN</td><td>pv</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/bundle.html\">Bundle</a></td><td/><td><div><p>Persona Vector</p>\n</div></td></tr><tr><td>IN</td><td>pv-identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>Persona Vector Identifier</p>\n</div></td></tr><tr><td>IN</td><td>language</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>Language of the ePI. The code must be picked from https://hl7.org/fhir/valueset-languages.html. Defaults to english if none is provided.</p>\n</div></td></tr><tr><td>OUT</td><td>returnEpi</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/bundle.html\">Bundle</a></td><td/><td><div><p>Focused epi Bundle</p>\n</div></td></tr><tr><td>OUT</td><td>returnEpiExtracts</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/bundle.html\">Bundle</a></td><td/><td><div><p>Focused epi Bundle extracts</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://hl7.eu/fhir/ig/gravitate-health/OperationDefinition/focus",
  "version" : "0.1.0",
  "name" : "focus",
  "title" : "focus",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-16T11:58:55+00:00",
  "publisher" : "Gravitate Health Project",
  "contact" : [
    {
      "name" : "Gravitate Health Project",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.gravitatehealth.eu/"
        }
      ]
    },
    {
      "name" : "Gravitate Health Project",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.gravitatehealth.eu/"
        }
      ]
    }
  ],
  "description" : "This operation calculates a focused version of an ePI as well as the separate extracts. The IPS can either be submitted as an IPS bundle or as an `Identifer` of the patient (using the `ips-identifier` parameter). If neither IPS Bundle or IPS identifier are passed as parameters it is expected that the `Identifier` of the patient is present as part of the security token. If the `Identifier` of the patient is submitted as an Identifier or as part of a security token it is up to the discression of the service implementing the `focus`-operation to fetch the IPS of the patient.\n\nIf the IPS is delivered as a bundle it must be encoded using Base64 as it is FHIR R4 compliant whereas the `focus`-operation is FHIR R5 compliant. The `focus`-operation will internally convert and extract the needed information from the R4 bundle.\n\nThe ePI can be delivered either as a `Bundle` or by using an `Identifier` of the bundle. Whether the support of both `Identifier` and `Bundle` continues to be supported currently remains unknown.\n\nThe persona dimension can be delivered either as a `Bundle` or by using an `Identifier` of the bundle. Whether the support of both `Identifier` and `Bundle` continues to be supported currently remains unknown.\n\n**Note: If the IPS is delivered as encoded Base64 content, there is a better opportunity for the submitting client to de-identify the Patient resource as the client can remove the Patient.identifier and mask out names and so on. While this may seem counter intuitive from an IPS point of view, the Patient identifiable components are not needed for the focusing mechanism to operate properly.**\n",
  "affectsState" : false,
  "code" : "focus",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "ips",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "IPS bundle packaged as base64Binary in order not to mix FHIR R4 with FHIR R5.",
      "type" : "base64Binary"
    },
    {
      "name" : "ips-identifier",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "IPS Patient Identifier",
      "type" : "Identifier"
    },
    {
      "name" : "epi",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "ePI Document Bundle",
      "type" : "Bundle"
    },
    {
      "name" : "epi-identifier",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "ePI Document Identifier",
      "type" : "Identifier"
    },
    {
      "name" : "pv",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Persona Vector",
      "type" : "Bundle"
    },
    {
      "name" : "pv-identifier",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Persona Vector Identifier",
      "type" : "Identifier"
    },
    {
      "name" : "language",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Language of the ePI. The code must be picked from https://hl7.org/fhir/valueset-languages.html. Defaults to english if none is provided.",
      "type" : "Coding"
    },
    {
      "name" : "returnEpi",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Focused epi Bundle",
      "type" : "Bundle"
    },
    {
      "name" : "returnEpiExtracts",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Focused epi Bundle extracts",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.